//! \file CoreTask.h
//! \brief TODO: Document
// -----------------------------------------------------------------------------
//! This program is free software; you can redistribute it and/or
//! modify it under the terms of the GNU General Public License
//! as published by the Free Software Foundation; either version 2
//! of the License, or (at your option) any later version.
//!
//! This program is distributed in the hope that it will be useful,
//! but WITHOUT ANY WARRANTY; without even the implied warranty of
//! MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//! GNU General Public License for more details.
//!
//! You should have received a copy of the GNU General Public License
//! along with this program; if not, write to the Free Software Foundation,
//! Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
// -----------------------------------------------------------------------------
#ifndef dCORE_THREAD_H_
#define dCORE_THREAD_H_

#include "CoreError.h"

//#ifdef __cplusplus
//extern "C"
//{
//#endif

namespace Core {

// =====[ Core Task Data Types ]================================================

//  // =============================================================================
//  //! \typedef tTHREAD
//  //! \brief TODO: document
//  // -----------------------------------------------------------------------------
//  //typedef pthread_t tTHREAD;
//  typedef unsigned long int tTHREAD;

// =============================================================================
//! \typedef tTHREAD_FUNCTION
//! \brief TODO: document
// -----------------------------------------------------------------------------
typedef void *(*tTASK_ROUTINE)(void *Arg);

// TODO: document
typedef tERROR (*tTASK_SHUTDOWN)(tERROR Error);

// TODO: document
typedef struct
{
  tTASK_ROUTINE pRoutine;
  tTASK_SHUTDOWN pShutdown;
} tTask;


// =============================================================================
// ThreadCreate
// -----------------------------------------------------------------------------
//! TODO: document
//!
//! \param [in] Arg
//!   TODO: document
//!
//! \retval Exception
//!   The success status of the requested operation.
//!   - eOKAY: Execution occurred as requested.
//!   .
//!
//! \b Example: \code
//! FxName(0);
//! \endcode
// -----------------------------------------------------------------------------
tERROR TaskNew(const tTask *pTask);


// =============================================================================
// FxName
// -----------------------------------------------------------------------------
//! TODO: document
//!
//! \param [in] Arg
//!   TODO: document
//!
//! \retval Exception
//!   The success status of the requested operation.
//!   - eOKAY: Execution occurred as requested.
//!   .
//!
//! \b Example: \code
//! FxName(0);
//! \endcode
// -----------------------------------------------------------------------------
void *TaskComplete(void *pValue);


// =============================================================================
// TaskRequestShutdown
// -----------------------------------------------------------------------------
//! TODO: document
//!
//! \param [in] Arg
//!   TODO: document
//!
//! \retval Exception
//!   The success status of the requested operation.
//!   - eOKAY: Execution occurred as requested.
//!   .
//!
//! \b Example: \code
//! FxName(0);
//! \endcode
// -----------------------------------------------------------------------------
void TaskRequestShutdown(tERROR Error);

// =============================================================================
// TaskWaitForShutdown
// -----------------------------------------------------------------------------
//! TODO: document
//!
//! \param [in] Arg
//!   TODO: document
//!
//! \retval Exception
//!   The success status of the requested operation.
//!   - eOKAY: Execution occurred as requested.
//!   .
//!
//! \b Example: \code
//! FxName(0);
//! \endcode
// -----------------------------------------------------------------------------
void TaskWaitForShutdown(void);

} // namespace Core


//#ifdef __cplusplus
//}
//#endif

#endif // dCORE_THREAD_H_

